package com.gitee.qdbp.general.common.api.reusable.basic;

import java.util.List;
import com.gitee.qdbp.able.exception.ServiceException;
import com.gitee.qdbp.able.jdbc.ordering.OrderPaging;
import com.gitee.qdbp.able.jdbc.paging.PageList;
import com.gitee.qdbp.general.common.api.reusable.model.ProcessingRecordBean;
import com.gitee.qdbp.general.common.api.reusable.model.ProcessingRecordUpdate;
import com.gitee.qdbp.general.common.api.reusable.model.ProcessingRecordWhere;

public interface IProcessingRecordBasic {

    /**
     * 处理过程备注查询
     *
     * @param where 查询条件
     * @return 处理过程备注
     * @throws ServiceException 查询失败
     */
    ProcessingRecordBean find(ProcessingRecordWhere where) throws ServiceException;

    /**
     * 根据过程ID查询处理过程备注
     *
     * @param id 过程ID
     * @return 处理过程备注
     * @throws ServiceException 查询失败
     */
    ProcessingRecordBean findById(String id) throws ServiceException;

    /**
     * 处理过程备注查询
     *
     * @param paging 排序分页条件
     * @return 处理过程备注列表
     * @throws ServiceException 查询失败
     */
    PageList<ProcessingRecordBean> list(OrderPaging paging) throws ServiceException;

    /**
     * 处理过程备注查询
     *
     * @param where 查询条件
     * @param paging 排序分页条件
     * @return 处理过程备注列表
     * @throws ServiceException 查询失败
     */
    PageList<ProcessingRecordBean> list(ProcessingRecordWhere where, OrderPaging paging) throws ServiceException;

    /**
     * 根据过程ID查询处理过程备注列表
     *
     * @param ids 过程ID列表
     * @return 处理过程备注列表
     * @throws ServiceException 查询失败
     */
    PageList<ProcessingRecordBean> listByIds(List<String> ids) throws ServiceException;

    /**
     * 创建处理过程备注
     *
     * @param model 待新增的处理过程备注
     * @return 受影响行数
     * @throws ServiceException 创建失败
     */
    int create(ProcessingRecordBean model) throws ServiceException;

    /**
     * 批量创建处理过程备注
     *
     * @param models 待新增的处理过程备注
     * @return 受影响行数
     * @throws ServiceException 创建失败
     */
    int create(List<ProcessingRecordBean> models) throws ServiceException;

    /**
     * 修改处理过程备注
     *
     * @param model 待修改的内容
     * @param errorOnUnaffected 受影响行数为0时是否抛异常
     * @return 受影响行数
     * @throws ServiceException 修改失败
     */
    int update(ProcessingRecordUpdate model, boolean errorOnUnaffected) throws ServiceException;

    /**
     * 根据过程ID删除处理过程备注
     *
     * @param ids 待删除的处理过程备注的过程ID
     * @param errorOnRowsNotMatch 删除行数不匹配时是否抛异常
     * @return 删除行数
     * @throws ServiceException 删除失败
     */
    int deleteByIds(List<String> ids, boolean errorOnRowsNotMatch) throws ServiceException;

    /**
     * 根据条件删除处理过程备注
     *
     * @param where 条件
     * @param errorOnUnaffected 删除行数为0时是否抛异常
     * @return 删除行数
     * @throws ServiceException 删除失败
     */
    int delete(ProcessingRecordWhere where, boolean errorOnUnaffected) throws ServiceException;

}
